CICS Transaction Gateway for Multiplatforms

https://www.ibm.com/docs/en/cics-tg-multi/10.1.0
Admin
CICS Transaction Gateway for Multiplatforms is an IBM middleware solution that enables communication...
Tokens:486,265
Snippets:4,827
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Start Minikube Environment

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=dctgmrsas-deploy-cics-transaction-gateway-minikube-run-sample-application-sc16

This command initiates the Minikube virtual machine, which serves as a local Kubernetes cluster. Ensure Minikube is installed and configured before running this command.

```bash
minikube start
```

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

### Example cicsterm Command Usage

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=printing-cicsterm-command-reference

This example demonstrates how to use the cicsterm command with multiple parameters to start a CICS terminal emulator. It specifies the server, initial transaction, keyboard and color mapping files, terminal definition, print file, and message suppression.

```bash
   cicsterm -s=CICSTSW -t=CESN -k=mykeys.ini -c=mycols.ini
            -n=cicsv123 -f=clprint.txt -q
```

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

### Configure CLASSPATH for Gateway

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=manager-setup-workload

This snippet shows how to add the ca1t.jar to the CLASSPATH environment variable for starting the Gateway. Ensure the path to 'classes/ca1t.jar' is correctly specified.

```shell
CLASSPATH=<install_path>/classes/ca1t.jar
```

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

### Unattended Install with Response File (Shell)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=installing-cics-transaction-gateway-unix-linux

Performs a silent installation using a response file. The response file, typically named installer.properties, must contain 'LICENSE_ACCEPTED=TRUE'. The command redirects standard output and standard error to a log file. Ensure the response file and installation image are accessible.

```shell
installer -i silent -f /tmp/installer.properties >/tmp/installer.log 2>&1
```

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

### Install IBM CICS TG in Console Mode with Language Selection

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=accessibility-installation

This command installs IBM CICS TG using the console interface and sets the installation language to French. It requires the `installer` executable and the `-i console` and `-l fr` options. The output is text-based, guiding the user through the installation steps.

```bash
installer -i console -l fr
```

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

### Example OS Level Output and Interpretation

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=problems-installation-fails-when-using-aix-71

Demonstrates a typical output from the 'oslevel -s' command and explains how to interpret the numbers to identify the Technology Level (TL) and Service Pack (SP).

```text
7100-01-01-1141

This is TL 1, SP 1. The second number is TL. The third number is the SP.
```

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

### Get Field Start Column - C++

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-column

Returns the column number of the position of the start of the field on the screen, with the leftmost column being 1. This function is part of the CICS Transaction Gateway interface.

```cpp
unsigned short column() const
```

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

### Unattended Installation with Response File (CLI)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=installing-cics-transaction-gateway-windows

Installs CICS Transaction Gateway silently using a predefined response file. This method requires the `installerResponseSamp.txt` file or a custom-generated response file with `LICENSE_ACCEPTED=TRUE`. The command redirects output to a log file.

```bash
installer.exe -i silent -f C:/temp/installer.properties >C:/temp/installer.log 2>&1
```

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

### Example CICS TG Version Check Output

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=cjiaiwlcuctgilms-creating-websphere-liberty-container-cics-transaction-gateway-in-local-mode

This is an example output of the `cicscli -v` command, showing the CICS Transaction Gateway version and build level installed within the container.

```bash
[root@0a0d8dc816dc bin]# cicscli -v
CCL8001I CICSCLI - CICS Transaction Gateway Client Daemon Control Program
CCL0002I (C) Copyright IBM Corporation 1994, 2025.  All rights reserved.
CCL8029I CICS Transaction Gateway for Multiplatforms for Linux on Intel Version 10.1.0.0
CCL8074I Build Level 'c1010-20250212-1202', 'GA'
CCL8023I CICSCLI performed no action
```

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

### CICS System Log Messages for IPCONN Installation

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=sc08-optional-using-applid-identify-your-cics-tg

These are example messages that appear in the CICS system log when an IPCONN is automatically installed. They show the identified APPLID and APPLIDQUALIFIER of the CICS TG client and the host from which the connection was received.

```text
DFHIS3000 .... IPCONN APPL with applid MYQUAL.MYAPPL 
autoinstalled successfully using autoinstall user program DFHISAIP 
and template NONE after a connection request was received on 
tcpipservice SRV50889 from host 1.23.456.789

DFHIS2001 .... Client session from applid MYAPPL accepted for IPCONN 
APPL.
```

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

### Display Configuration Tool Help (Shell)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=configuring-creating-configuration-file

This command displays help information for the `ctgcfg` Configuration Tool, listing available options and operating system codes. It is a prerequisite for determining the correct `OSCODE` for emulation.

```shell
ctgcfg -?
```

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

### Example: Launch Application with Request Monitoring

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=statistics-configuring-request-monitoring-gateway-classes

Demonstrates how to launch a Java application with a specific request monitoring exit class configured via the JVM property. This example shows the command-line syntax.

```bash
java -DrequestExits=com.ibm.ctg.samples.requestexit.BasicMonitor com.ibm.ctg.samples.eci.EciB1
```

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

### Install TCPIPSERVICE Definition (CICS)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=tcpip-configuring-cics-transaction-server-zos

This command installs a previously defined TCPIPSERVICE resource into the CICS system. Ensure the group containing the service is part of the GRPLIST in the CICS startup to enable the listener upon CICS start.

```CICS JCL
CEDA INS TCPIPSERVICE(service-name) GROUP(group-name)
```

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

### Install TP Client using tpinst32 command

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=windows-configuring-ati

This command-line instruction is used to install the Transaction Program (TP) client. It requires the path to a configuration file (e.g., filename.cfg) that contains the transaction definitions.

```shell
tpinst32 -a filename.cfg
```

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

### Start CICS TG Container to Get ctg.ini

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=container-configuring-cics-tg

This command starts the CICS TG container, mounts the current working directory to `/var/cicscli` inside the container, and accepts the license. This process copies the sample `ctg.ini` file from the container to your current directory, allowing you to configure the Gateway.

```shell
docker run -v $PWD:/var/cicscli -e LICENSE=accept --name ctgcontainer ibm-cicstg-container-linux-x86:10.1
```

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

### Run ctgecib2 Sample Program

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=samples-c-ctgecib2-sample

Command to start the compiled ctgecib2 sample program. It requires parameters for host name, port number, number of calls, user ID, and password.

```bash
ctgecib2 [host name] [port number] [num calls] [user id] [password]
```

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

### Create Server Key Ring and Certificate using keytool

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=management-configuring-your-ssl-server

Generates a key pair and wraps the public key into a self-signed certificate. This command creates a keystore and a certificate with specified parameters like alias, key size, distinguished name, keystore location, passwords, and algorithm.

```shell
keytool -genkey -alias aliasname -keysize numericvalue -dname distname -keystore location -keypass password -storepass password -keyalg algorithm
```

```shell
keytool -genkey -alias exampleServerCert -keysize 1024 -dname "cn=someserver.location.ibm.com,o=IBM,ou=IBMGB,l=Winchester,s=Hants,c=GB" -keystore ktserverss.jks -keypass default -storepass default -keyalg RSA
```

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

### GET /websites/ibm_en_cics-tg-multi_10_1_0/signonCapability

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-signoncapability

Retrieves the type of sign-on capability applied to the terminal at installation. The response indicates whether the terminal is sign-on capable, incapable, or if the status is unknown.

```APIDOC
## GET /websites/ibm_en_cics-tg-multi_10_1_0/signonCapability

### Description
Returns the type of sign-on capability applied to the terminal at installation.

### Method
GET

### Endpoint
/websites/ibm_en_cics-tg-multi_10_1_0/signonCapability

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **signonCapability** (string) - The sign-on capability of the terminal. Possible values are: `CclTerminal::signonCapable`, `CclTerminal::signonIncapable`, `CclTerminal::signonUnknown`.

#### Response Example
```json
{
  "signonCapability": "CclTerminal::signonCapable"
}
```
```

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

### Build ctgecib2 Product Sample (UNIX/Linux)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=samples-c-ctgecib2-sample

Command to build the 64-bit ctgecib2 product sample on UNIX and Linux platforms using the provided makefile. Ensure you are in the correct directory before execution.

```bash
make -f samp64.mak
```

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

### Unattended Installation without Response File (CLI)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=installing-cics-transaction-gateway-windows

Performs a silent installation of CICS Transaction Gateway directly via the command line, without using a response file. The license acceptance is specified using a system property (`-D`). Output is redirected to a log file.

```bash
installer.exe -i silent -DLICENSE_ACCEPTED=true >C:/temp/installer.log 2>&1
```

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

### Get Data Area Type (C++ Example)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-dataareatype

This C++ code snippet demonstrates how to use the `dataAreaType()` method to determine if a data area is extensible or fixed. It returns an enumeration value.

```cpp
DataAreaType dataAreaType() const
```

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

### Get Field Background Color (C++ Example)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-backgroundcolor

This C++ code snippet demonstrates how to retrieve the background color of a field using the 'backgroundColor()' method. It returns an enumeration value representing the color.

```cpp
Color backgroundColor() const
```

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

### Get CICS TG License Service URL (Kubernetes)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=kubernetes-retrieving-cics-tg-license-service-data

This command retrieves the URL for the IBM License Service instance. It uses kubectl to get routes in the 'ibm-common-services' namespace and filters for the 'ibm-licensing-service-instance'. The output provides the base URL for API access, assuming foundational services are installed in the 'ibm-commonservices' namespace.

```shell
kubectl get routes -n ibm-common-services | grep ibm-licensing-service-instance | awk '{print $2}'
```

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

### Interpreting CICS Transaction Gateway Version Output

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=installing-product-versions

This example demonstrates the typical output from the 'cicscli -v' command on IBM AIX. It highlights key messages like CCL8029I for the product version and CCL8074I for the build level and installation type (GA or FP). Understanding these messages is crucial for determining the exact version and status of the CICS Transaction Gateway installation.

```text
CCL8001I CICSCLI - CICS Transaction Gateway Client Daemon Control Program
CCL0002I (C) Copyright IBM Corporation 1994, 2025.  All rights reserved.
CCL8029I CICS Transaction Gateway for Multiplatforms for AIX Version 10.1.0.0
CCL8074I Build Level 'c1010-20250212-1202', 'GA'
CCL8023I CICSCLI performed no action
```

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

### Generating a Response File (Shell)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=installing-cics-transaction-gateway-unix-linux

This command generates a response file named 'installer.properties' in the specified directory or the current working directory if none is specified. This file can then be used for unattended installations.

```shell
installer -r <path_to_generate_response_file>
```

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

### Build ctgecib2 SDK Sample (Linux on POWER with XL C)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=samples-c-ctgecib2-sample

Command to build the 64-bit ctgecib2 SDK sample on Linux on POWER systems using IBM XL C. The OS=<platform> and COMPILER=XL arguments are used.

```bash
make -f make64 OS=<platform> COMPILER=XL
```

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

### Install ECI Resource Adapter in WebSphere Liberty

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=sc19-loading-cics-transaction-gateway-container-image

This XML snippet shows how to configure the ECI resource adapter to start automatically in WebSphere Liberty. It specifies the ID, the auto-start setting, and the location of the resource adapter archive (.rar file).

```xml
<resourceAdapter autoStart="true" id="eciResourceAdapter" 
location="/opt/ibm/cicstg/deployable/cicseci.rar">
      </resourceAdapter>
```

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

### Get UOW Identifier (UowId)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=m-uowid

Retrieves the identifier for the current Unit of Work (UOW). A UOW is considered inactive if it has not yet started or has already completed, indicated by a return value of 0. This function returns a 'long' data type.

```pseudocode
UowId() as long
```

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

### Build ctgecib2 SDK Sample (Windows)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=samples-c-ctgecib2-sample

Command to build the 64-bit ctgecib2 SDK sample on Windows platforms. This is a simplified make command for the SDK sample.

```bash
make 64
```

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

### Initiate Transaction with EPIInteractionSpec in Java

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=model-episcreenrecord

Demonstrates starting a new transaction by configuring an EPIInteractionSpec and executing it with an EPIScreenRecord. It highlights setting the function name, AID, and interaction verb for synchronous send and receive operations.

```java
EPIInteractionSpec epiSpec = new EPIInteractionSpec(); epiSpec.setFunctionName(“CESN”);epiSpec.setAID(AIDKey.enter);epiSpec.setInteractionVerb(EPIInteractionSpec.SYNC_SEND_RECEIVE);
//epiInter is an interaction created elsewhere epiInter.execute(epiSpec, null, screen);
```

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

### Get Field Row Number (Integer)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=m-row

The Row() function returns an integer representing the screen row number where a field starts. The top row of the screen is considered row 1. This function is essential for positioning or identifying elements within the screen layout.

```COBOL
01  FIELD-ROW   PIC 99.

PROCEDURE DIVISION.
    MOVE FUNCTION ROW() TO FIELD-ROW.
    DISPLAY "The field starts on row: " FIELD-ROW.
```

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

### Get Unit of Work Identifier (C++)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-uowid

This C++ code snippet demonstrates how to retrieve the identifier for the current Unit of Work (UOW) using the `uowId()` method. It returns an unsigned long representing the UOW ID. A value of 0 signifies an inactive UOW (either not started or completed).

```cpp
unsigned long uowId() const
```

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

### Build ctgecib2 SDK Sample (UNIX/Linux)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=samples-c-ctgecib2-sample

Command to build the 64-bit ctgecib2 SDK sample on UNIX and Linux platforms. The OS=<platform> argument specifies the target operating system environment.

```bash
make -f make64 OS=<platform>
```

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

### Start CICS Transaction Gateway on UNIX/Linux using ctgstart

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=reference-ctgstart-command

The 'ctgstart' command initiates the CICS Transaction Gateway on UNIX and Linux systems. It accepts various options to customize the startup process, including JVM arguments and CICS CLI arguments. To view all available options, use 'ctgstart -?'. Some options can be configured via the 'CTGD_PARAMS' environment variable for the 'ctgd' daemon.

```bash
ctgstart <options> [<-j>JVMArg1 <-j>JVMArg2...] [<-c>CicscliArg1 <-c>CicscliArg2...]
```

```bash
ctgstart -?
```

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

### Get Terminal Sign-on Capability (C++ Example)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-signoncapability

This C++ snippet demonstrates how to call the `signonCapability()` function to retrieve the sign-on capability of a terminal. It relies on the `CclTerminal` library. The function returns an enum value indicating whether the terminal is capable, incapable, or unknown regarding sign-on.

```cpp
int signonCapability() {
  // Returns the type of sign-on capability applied to the terminal at installation.
  // Possible values are:
  // * CclTerminal::signonCapable
  // * CclTerminal::signonIncapable
  // * CclTerminal::signonUnknown
  return CclTerminal::signonCapable; // Example return value
}
```

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

### Set Gateway Trace System Property in Java

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=programs-tracing-in-java-client

This example shows how to set the gateway.T trace system property to enable full debug trace for a Java application. This is done via the Java command line when starting the application. It is useful for detailed debugging of gateway interactions.

```java
java -Dgateway.T=on com.usr.smp.test.testprog1
```

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

### Instantiate EPIScreenRecord in Java

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=model-episcreenrecord

This snippet shows how to create an instance of EPIScreenRecord using its implementation class EPIScreenRecordImpl. This is the first step in interacting with screen data.

```java
EPIScreenRecord screen = new EPIScreenRecordImpl();
```

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

### Get CclUOW Object Pointer (C++ Example)

Source: https://www.ibm.com/docs/en/cics-tg-multi/10.1.0/index_topic=methods-uow

This function returns a pointer to a CclUOW object, which contains information about units of work (UOWs) associated with the current interaction. This is a C++ function, and its usage typically involves dereferencing the returned pointer to access UOW details.

```cpp
CclUOW* uow() const
```
Tokens:
Raw