IBM CICS TX

https://www.ibm.com/docs/en/cics-tx
Admin
IBM CICS TX is an IBM transaction processing product, providing a robust and scalable environment...
Tokens:311,126
Snippets:3,025
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Sample input file create.input

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=reference-cicsodt-oracle-diagnostic-tool

Example input file for cicsodt that creates a table called qsamtest. Each line is treated as an interactive command, and comments start with /*.

```text
/*
/* This is a sample file to create a table called qsamtest
/*
create cics.qsamtest
k
fl
char
10
f2
raw
100
long raw

f1
a
 
quit

```

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

### Sample input file create.input

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=reference-cicssdt-sfs-diagnostic-tool

Example input file for the -i option. Each line is executed as if typed interactively; comments start with /*. This file creates a SFS file named qsamTest.

```plaintext
/*
/* This is a sample file to create a SFS file called qsamTest
/*
create qsamTest
 
b
fl
byteArray
10
f2
varLenByteArray
100
 
f1
y
f1
a
 
1
quit
```

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

### Install PostgreSQL client-only files

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=postgresql-preparing-cics-tx-container-c-programs

Install the PostgreSQL client-only files after building. These commands install the binaries, headers, interfaces, and documentation. After installation, add the binaries to the CICSTX container and set the ESQLPATH environment variable to their path.

```bash
make  -C  src/bin install
make  -C  src/include install
make  -C src/interfaces install
make -C doc install

```

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

### Install 32-bit PostgreSQL client binaries

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=suctp-preparing-cics-tx-container-postgresql-cobol-it-programs

Client-only installation commands for the built 32-bit PostgreSQL binaries. Installs the bin, include, interfaces, and doc components. After installation, add the binaries to the CICSTX container and set the path in the ESQLPATH environment variable.

```bash
make  -C  src/bin install
make  -C  src/include install
make  -C src/interfaces install
make -C doc install
```

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

### Install missing Linux package libpwquality

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=taci-resolving-failure-in-logging-into-administration-console-file-permission-issues

Run this command to install the missing library /usr/lib/security/pam_pwquality.so.

```bash
- yum install libpwquality
```

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

### Start SFS server with cicscp and expected output

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=manager-creating-sfs-server-using-logical-volumes

Starts the SFS server sfs02 with a cold start using the cicscp command. The output shows the startup process, including initializing the subsystem, creating logical volumes, and enabling the server.

```shell
# cicscp -v start sfs_server sfs02 StartType=cold
```

```text
ERZ058504I/0107: Starting RPC daemon.
ERZ058502I/0101: RPC daemon is already running.
ERZ096111I/0224: Processing a start sfs_server command.
ERZ096141I/0224: Starting SFS server /.:/cics/sfs/sfs02.
ERZ038214I/0168: Authorization for server /.:/cics/sfs/sfs02 has been set
to **none**.
ERZ038216I/0175: Subsystem **cicssfs.Ssfs02** has been initialized.
ERZ038272I/0157: Waiting for server /.:/cics/sfs/sfs02 to initialize.
ERZ038219I/0179: Server /.:/cics/sfs/sfs02 is responding to RPCs.
ERZ036204I/0251: Created logical volume 'log_Ssfs02' for server
/.:/cics/sfs/sfs02.
ERZ036206I/0253: Initialized logical volume 'log_Ssfs02' initialized for logging by server
/.:/cics/sfs/sfs02.
ERZ036208I/0255: Created log file 'log_Ssfs02/logfile' for server
/.:/cics/sfs/sfs02.
ERZ036231I/0260: Log file 'logfile' on server /.:/cics/sfs/sfs02 has been
enabled.
ERZ036233I/0262: Logical volumes on server /.:/cics/sfs/sfs02 have been
recovered.
ERZ038228I/0189: Server /.:/cics/sfs/sfs02 has been enabled.
ERZ038223I/0192: SFS Logical volume **sfs_Ssfs02** has been created for server
/.:/cics/sfs/sfs02.
ERZ038224I/0194: Logical volume **sfs_Ssfs02** on server
/.:/cics/sfs/sfs02 has been enabled.
ERZ038226I/0196: Logical volume **sfs_Ssfs02** has been added to server
/.:/cics/sfs/sfs02.
ERZ038182I/0182: Server /.:/cics/sfs/sfs02 started successfully.
ERZ096113I/0231: SFS server has /.:/cics/sfs/sfs02 successfully
started.
ERZ096002I/0003: The cicscp command has completed successfully.
```

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

### Install PostgreSQL switchload file

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=postgresql-configuring-one-phase-switchload-file

This command installs the PostgreSQL switchload file, which installs the XAOpen entries in XAD.stanza for a single-phase XA connection.

```bash
make -f postgresql1pc.mk install

```

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

### Start an SFS server

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=manager-configuring-sfs-as-file-commands

Use the cicscp start sfs_server command to initiate the SFS server process.

```bash
# <Installation directory>/bin/cicscp -v start sfs_server \
 sfs_server_name
```

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

### Start the Liberty server

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=services-configuring-cics-tx-inbound-web

Command to start the Liberty server hosting CICS TX web services.

```bash
   # /opt/ibm/cics/wui/bin/server start txserver
```

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

### Start CICS TX Standard container with example ports

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=standard-getting-started-cics-cobol-application

Starts a CICS TX Standard container with example port mappings (3270:3270 and 1435:1435) and license acceptance. The container name is standard-aor2.

```bash
docker run -p 3270:3270 -p 1435:1435 \
-itd -e LICENSE=accept --name=standard-aor2 \
--network=ibm-cics-tx ibm-cics-tx-standard:11.1.0.0
```

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

### Set JAVA_HOME environment variable

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=support-setting-java-home

Sets the JAVA_HOME environment variable to the JRE installation directory. Replace the example location with the actual installation path of your JRE.

```bash
export JAVA_HOME=/usr/opt/IBMJava2-141
```

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

### Create and start a CICS SFS server

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=reference-cicssfscreate-create-cics-sfs

Steps to create an SFS and start the SFS server. First run cicssfscreate with the server name and ShortName attribute, then manually create logical volumes and ensure user/group are cics, and finally start the server with cicssfs.

```shell
cicssfscreate /.:/cics/sfs/_sfs_servername_ 
   ShortName=_shortname_of_server_ 

```

```shell
cicssfs /.:/cics/sfs/_sfs_servername_

```

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

### Start SFS server with cicscp

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=reference-cicscp-create-destroy-stop-start-sfs

Starts server /.:/cics/sfs/SrvTwo with an attribute override. This example performs an implicit create, so specifying ShortName=Sfs2 would not work because the ShortName default would have been used during the create.

```shell
cicscp start sfs_server SrvTwo MRAArchivingEnabled=yes
```

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

### Modify Transaction Definition with cicsupdate

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=commands-example-configuring-transaction-definitions

Modifies a Transaction Definition entry so it is not installed at the next cold start by setting ActivateOnStartup=no and clearing GroupName. If GroupName contains a group in the region's Groups list, the entry is installed regardless of ActivateOnStartup.

```shell
cicsupdate -c td -r regionA -P TRN1 ActivateOnStartup=no GroupName=''
```

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

### Build and install CICS socket sample

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=samples-cics-socket-sample

Build the sample programs using the supplied makefile, then define the required CICS programs and transactions. Run the listener daemon as user ID CICS to avoid errors on subsequent connection attempts.

```makefile
make -f makefile.platform all
```

```makefile
make -f makefile.platform install
```

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

### /etc/services entries for TCP listeners

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=tcpip-configuring-cics-family-support

Example entries from /etc/services for three TCP listeners. Each line defines a service name, port number, and /tcp protocol, with an optional comment starting with a hash character.

```plaintext
 cicstcp1    8595/tcp        # TCP listener1 for region regionName
 cicstcp2    8596/tcp        # TCP listener2 for region regionName
 cicstcp3    8597/tcp        # TCP listener3 for region regionName
```

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

### Add Transaction Definition with cicsadd

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=commands-example-configuring-transaction-definitions

Adds a Transaction Definition entry with key TRN1 to group Sales in the permanent database. If the region's Groups list includes Sales, the entry is installed at the next cold start; otherwise use cicsinstall.

```shell
cicsadd -c td -r regionA -P TRN1 GroupName='Sales'
```

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

### Enable debugging for prog1 and prog2

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=operators-enable-debugging-cics-programs

Example YAML to enable debugging for CICS programs named hello and abcd. Uses podName cicstx-app, regionName TXREGION, and debugClient 9.77.196.3:8001. Debugging is enabled for user CICSUSER, so the CICS resource must be run with the same user to start debugger sessions.

```yaml
apiVersion: cicstx.ibm.com/v1
kind: CICSTXDebug
metadata:
  name: cicstx-1-debug
spec:
  podName: cicstx-app
  regionName: TXREGION
  resourceName:
     - hello
     - abcd
  resourceType: pd
  CICSPassword: CICSUSER
  CICSUser: CICSUSER
  debugClient: 9.77.196.3:8001

```

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

### Run /work/lbr-setup.sh to tune LBR region and SFS

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=performance-tuning-load-balancing-region

Run the IBM supplied script /work/lbr-setup.sh to tune the LBR region and SFS server parameters. The first example uses the default names LBRREGN and LBRSFS for the IBM supplied image. The second shows the syntax with placeholders for the region name and SFS server name.

```bash
/work/lbr-setup.sh LBRREGN LBRSFS
```

```bash
/work/lbr-setup.sh  <RegionNameOfLBR> <SFSonFrontEndPod>
```

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

### docker run to start CICS TX Standard container

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=standard-deploying-cics-tx-container

Starts a CICS TX Standard container with the default region TXREGION and SFS Server TXSFS. The first command uses placeholder target ports; the second shows a concrete example mapping 3270 and 1435. Set LICENSE=accept to accept the IBM CICS TX license, or LICENSE=view to view it; use LANG to change the license language. The image provisions an IPIC port on 1435, a CICSTELD port on 3270, and a configured IVP.

```bash
docker run -p CICSTELD_TARGET_PORT:3270 \
-p IPIC_LISTENER_TARGET_PORT:1435 \
-itd -e LICENSE=accept --name=standard-aor1 \
--network=ibm-cics-tx ibm-cics-tx-standard:11.1.0.0
```

```bash
docker run -p 3270:3270 -p 1435:1435 \
-itd -e LICENSE=accept --name=standard-aor2 \
--network=ibm-cics-tx ibm-cics-tx-standard:11.1.0.0
```

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

### Sample provider XML file for WSSE security

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=services-configuring-transport-handler-web-service-security-handler

Example provider XML file that configures only a WSSE security handler with basic authentication. Note the spaces in the trust and mode attribute values.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<provider_pipeline xmlns="https://www.ibm.com/in-en/marketplace/cics-tx-on-cloud">

<service>

    <service_handler_list>
      <wsse_handler>
        <dfhwsse_configuration version="1">
           <authentication trust=" blind" mode= "basic" >
           </authentication>
        </dfhwsse_configuration>
      </wsse_handler>
    </service_handler_list>

</service>
</provider_pipeline>  

```

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

### Start CICS region cold (cicscp start region)

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=mq-setting-up-interface

Starts the CICS region with a cold start. Use this command if the region is not newly created; otherwise follow the steps in 'Working with a file manager in a CICS region'.

```bash
cicscp start region regionName StartType=cold
```

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

### Dockerfile to copy setup.sh to /work

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=postgresql-configuring-one-phase-switchload-file

This Dockerfile snippet shows how to copy the setup.sh script to the container's /work directory. It is used to set up the single-phase PostgreSQL XA connection for COBOL programs in a CICS TX container.

```dockerfile
#Dockerfile
FROM ibm-cics-tx-on-cloud:11.1.0.0-tfix1
COPY setup.sh /work/setup.sh

```

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

### dumpcicsthreads example: default settings

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=dumps-collecting-stack-all-processes-dumpcicsthreads

Command to create three sets of thread stacks at 30 second intervals using the default settings.

```bash
$ dumpcicsthreads <region name>
```

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

### cicssdt help command

Source: https://www.ibm.com/docs/en/cics-tx/11.1?topic=reference-cicssdt-sfs-diagnostic-tool

Gives general or specific online help for SDT commands. The example shows the help command for the create command.

```shell
cicssdt -s SFSname ? create
```
Tokens:
Raw